Package com.cisco.pt.ipc.sim
Interface HostPort
- All Known Subinterfaces:
FRSubInterface,RoutedSwitchPort,RouterPort,VirtualTemplateInterface
- All Known Implementing Classes:
FRSubInterfaceImpl,HostPortImpl,RoutedSwitchPortImpl,RouterPortImpl,VirtualTemplateInterfaceImpl
Information provided by the PKI file:
\class HostPort
\brief HostPort handles and manipulates the port configurations on end devices.
\example network().getDevice("PC0").getPort("FastEthernet0")
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionbooleanaddIpv6Address(IPV6Address ipAddress, int prefix, IPV6AddressType type, boolean bAllowDup) Information provided by the PKI file:Information provided by the PKI file:intgetIpMtu()Information provided by the PKI file:getIpv6Address(IPV6Address ipAddress) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intgetMtu()Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:booleanhasIpv6Address(IPV6Address ipAddress) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanisInIpv6Multicast(IPV6Address ipAddress) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidInformation provided by the PKI file:booleanremoveIpv6Address(IPV6Address ipAddress, int prefix, IPV6AddressType type) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetDefaultGateway(IPAddress gateway) Information provided by the PKI file:voidsetDhcpClientFlag(boolean bFlag) Information provided by the PKI file:voidsetDnsServerIp(IPAddress gateway) Information provided by the PKI file:voidsetInboundFirewallService(boolean bEnable) Information provided by the PKI file:voidsetInboundIpv6FirewallService(boolean bEnable) Information provided by the PKI file:voidsetIpMtu(int mtu) Information provided by the PKI file:voidsetIpSubnetMask(IPAddress newIpAddress, IPAddress newMask) Information provided by the PKI file:voidsetIpv6AddressAutoConfig(boolean bAutoConfig) Information provided by the PKI file:voidsetIpv6Enabled(boolean bEnable) Information provided by the PKI file:voidsetIpv6LinkLocal(IPV6Address ipAddress) Information provided by the PKI file:voidsetIpv6Mtu(int mtu) Information provided by the PKI file:voidsetMtu(int mtu) Information provided by the PKI file:voidsetv6DefaultGateway(IPV6Address gateway) Information provided by the PKI file:voidsetv6ServerIp(IPV6Address gateway) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Port
deleteLink, getBandwidth, getBia, getChannel, getClockRate, getDescription, getEncapProcess, getHardwareQueue, getHigherProcessCount, getKeepAliveProcess, getLightStatus, getLink, getMacAddress, getName, getPortNameNumber, getPower, getQosQueue, getTerminalTypeShortString, getType, isAutoCross, isBandwidthAutoNegotiate, isDuplexAutoNegotiate, isEthernetPort, isFullDuplex, isPortUp, isPowerOn, isProtocolUp, isStraightPins, isWirelessPort, setBandwidth, setBandwidthAutoNegotiate, setChannel, setClockRate, setDescription, setDuplexAutoNegotiate, setFullDuplex, setMacAddress, setPowerMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Method Details
-
setIpSubnetMask
Information provided by the PKI file:
\brief Configures a static IP address and subnet mask on the port. \param newIpAddress, the IP address. \param newMask, the subnet mask.- Parameters:
newIpAddress- Takes in a parameter of newIpAddressnewMask- Takes in a parameter of newMask
-
setDefaultArpTimeout
void setDefaultArpTimeout()Information provided by the PKI file:
\brief Sets the default timer time for ARP. -
setDhcpClientFlag
void setDhcpClientFlag(boolean bFlag) Information provided by the PKI file:
\brief Enables or disables the DHCP client on the port. \param bFlag, true to enable the DHCP client, false to disable it.- Parameters:
bFlag- Takes in a parameter of bFlag
-
isDhcpClientOn
boolean isDhcpClientOn()Information provided by the PKI file:
\brief Returns true if the DHCP client is enabled, otherwise false. \return bool, true if the DHCP client is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
getIpAddress
IPAddress getIpAddress()Information provided by the PKI file:
\brief Returns the IP address configured on the port. \return ip, the IP address configured on the port.- Returns:
- IPAddress Returns a IPAddress
-
getSubnetMask
IPAddress getSubnetMask()Information provided by the PKI file:
\brief Returns the subnet mask configured on the port. \return ip, the subnet mask configured on the port.- Returns:
- IPAddress Returns a IPAddress
-
setIpv6Enabled
void setIpv6Enabled(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables IPv6 on the port. \param bEnable, true to enable IPv6, false to disable it.- Parameters:
bEnable- Takes in a parameter of bEnable
-
isIpv6Enabled
boolean isIpv6Enabled()Information provided by the PKI file:
\brief Returns true if IPv6 is enabled on the port, otherwise false. \return bool, true if IPv6 is enabled on the port, otherwise false.- Returns:
- boolean Returns a boolean
-
setIpv6AddressAutoConfig
void setIpv6AddressAutoConfig(boolean bAutoConfig) Information provided by the PKI file:
\brief Enables or disables IPv6 auto config. \param bAutoConfig, true to enable IPv6 auto config, false to disable it.- Parameters:
bAutoConfig- Takes in a parameter of bAutoConfig
-
isIpv6AddressAutoConfig
boolean isIpv6AddressAutoConfig()Information provided by the PKI file:
\brief Returns true if IPv6 auto config is enabled, otherwise false. \return bool, true if IPv6 auto config is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
isSetToDhcpv6
boolean isSetToDhcpv6()Information provided by the PKI file:
\brief Returns true if port is set to DHCP v6, otherwise false. \return bool, true if port is set to DHCP v6, otherwise false.- Returns:
- boolean Returns a boolean
-
setIpv6LinkLocal
Information provided by the PKI file:
\brief Sets the IPv6 link-local address. \param ipAddress, the IPv6 link-local address.- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getIpv6LinkLocal
IPV6Address getIpv6LinkLocal()Information provided by the PKI file:
\brief Returns the IPv6 link-local address. \return ipv6, the IPv6 link-local address.- Returns:
- IPV6Address Returns a IPV6Address
-
addIpv6Address
Information provided by the PKI file:
\brief Configures a static IPv6 address and network prefix on the port. \param ipAddress, the IPv6 address. \param prefix, the network prefix. \param type, the IPv6 address type. IPv6 address types: eUnicast = 0, eAnycast = 1, eEui64 = 2, eNdAssigned = 3, eDhcpAssigned = 4 \param bAllowDup, true to allow duplicate IPv6 addresses, false to disallow duplicate IPv6 addresses.- Parameters:
ipAddress- Takes in a parameter of ipAddressprefix- Takes in a parameter of prefixtype- Takes in a parameter of typebAllowDup- Takes in a parameter of bAllowDup- Returns:
- boolean Returns a boolean
-
removeIpv6Address
Information provided by the PKI file:
\brief Removes the IPv6 configuration from the port. \param ipAddress, the IPv6 address. \param prefix, the network prefix. \param type, the IPv6 address type. IPv6 address types: eUnicast = 0, eAnycast = 1, eEui64 = 2, eNdAssigned = 3, eDhcpAssigned = 4- Parameters:
ipAddress- Takes in a parameter of ipAddressprefix- Takes in a parameter of prefixtype- Takes in a parameter of type- Returns:
- boolean Returns a boolean
-
removeAllIpv6Addresses
void removeAllIpv6Addresses()Information provided by the PKI file:
\brief Removes all IPv6 address configurations. -
hasIpv6Address
Information provided by the PKI file:
\brief Returns true if the specified IPv6 address is configured on the port, otherwise false. \param ipAddress, the IPv6 address of interest. \return bool, true if the specified IPv6 address is configured on the port, otherwise false.- Parameters:
ipAddress- Takes in a parameter of ipAddress- Returns:
- boolean Returns a boolean
-
getIpv6Address
Information provided by the PKI file:
\brief Returns the Ipv6AddressConfig object of the specified IPv6 address. \param ipAddress, the IPv6 address of interest. \return Ipv6AddressConfig, the Ipv6AddressConfig object of the specified IPv6 address.- Parameters:
ipAddress- Takes in a parameter of ipAddress- Returns:
- IPV6AddressConfig Returns a IPV6AddressConfig
-
getUnicastIpv6Address
IPV6Address getUnicastIpv6Address()Information provided by the PKI file:
\brief Returns a list of Ipv6AddressConfig objects associated to the port. \return vector<Ipv6AddressConfig>, a list of Ipv6AddressConfig objects associated to the port.- Returns:
- IPV6Address Returns a IPV6Address
-
getUnicastIpv6Prefix
int getUnicastIpv6Prefix()Information provided by the PKI file:
\brief Returns the port's Unicast Ipv6 Prefix. \return int, the port's Unicast Ipv6 Prefix.- Returns:
- int Returns a int
-
getIpv6Addresses
List<IPV6AddressConfig> getIpv6Addresses()Information provided by the PKI file:
\brief Returns a list of Ipv6AddressConfig objects associated to the port. \return vector<Ipv6AddressConfig>, a list of Ipv6AddressConfig objects associated to the port.- Returns:
- List<IPV6AddressConfig> Returns a List<IPV6AddressConfig>
-
isInIpv6Multicast
Information provided by the PKI file:
\brief Returns true if specified IPv6 address is a multicast address, otherwise false. \param ipAddress, the IPv6 address of interest. \return bool, true if specified IPv6 address is a multicast address, otherwise false.- Parameters:
ipAddress- Takes in a parameter of ipAddress- Returns:
- boolean Returns a boolean
-
getIpv6Multicast
List<IPV6Address> getIpv6Multicast()Information provided by the PKI file:
\brief Returns a list of IPv6 multicast addresses configured on the port. \return vector<ipv6>, a list of IPv6 multicast addresses configured on the port.- Returns:
- List<IPV6Address> Returns a List<IPV6Address>
-
setMtu
void setMtu(int mtu) Information provided by the PKI file:
\brief Sets the maximum transmission unit (MTU) value on the port. \param mtu, the MTU value.- Parameters:
mtu- Takes in a parameter of mtu
-
getMtu
int getMtu()Information provided by the PKI file:
\brief Returns the maximum transmission unit (MTU) value configured on the port. \return int, the MTU value.- Returns:
- int Returns a int
-
setIpMtu
void setIpMtu(int mtu) Information provided by the PKI file:
\brief Sets the IP maximum transmission unit (MTU) value on the port. \param mtu, the IP MTU value.- Parameters:
mtu- Takes in a parameter of mtu
-
getIpMtu
int getIpMtu()Information provided by the PKI file:
\brief Returns the IP maximum transmission unit (MTU) value configured on the port. \return int, the IP MTU value.- Returns:
- int Returns a int
-
setIpv6Mtu
void setIpv6Mtu(int mtu) Information provided by the PKI file:
\brief Sets the IPv6 maximum transmission unit (MTU) value on the port. \param mtu, the IP MTU value.- Parameters:
mtu- Takes in a parameter of mtu
-
getIpv6Mtu
int getIpv6Mtu()Information provided by the PKI file:
\brief Returns the IPv6 maximum transmission unit (MTU) value configured on the port. \return int, the IPv6 MTU value.- Returns:
- int Returns a int
-
setDefaultGateway
Information provided by the PKI file:
\brief Sets the default gateway for this port. \param gateway, the IP address of the default gateway.- Parameters:
gateway- Takes in a parameter of gateway
-
setDnsServerIp
Information provided by the PKI file:
\brief Sets the DNS server gateway for this port. \param gateway, the IP address of the DNS gateway.- Parameters:
gateway- Takes in a parameter of gateway
-
setv6ServerIp
Information provided by the PKI file:
\brief Sets the DNS Server IPv6 gateway for this port. \param gateway, the IPv6 address of the DNS gateway.- Parameters:
gateway- Takes in a parameter of gateway
-
setv6DefaultGateway
Information provided by the PKI file:
\brief Sets the default IPv6 gateway for this port. \param gateway, the IPv6 address of the default gateway.- Parameters:
gateway- Takes in a parameter of gateway
-
isInboundFirewallOn
boolean isInboundFirewallOn()Information provided by the PKI file:
\brief Returns true if the IPv4 inbound firewall is enabled, otherwise false. \return bool, true if the IPv4 inbound firewall is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
setInboundFirewallService
void setInboundFirewallService(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the IPv4 inbound firewall. \param bEnable, true to enable the IPv4 inbound firewall, false to disable it.- Parameters:
bEnable- Takes in a parameter of bEnable
-
isInboundIpv6FirewallOn
boolean isInboundIpv6FirewallOn()Information provided by the PKI file:
\brief Returns true if the IPv6 inbound firewall is enabled, otherwise false. \return bool, true if the IPv6 inbound firewall is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
setInboundIpv6FirewallService
void setInboundIpv6FirewallService(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the IPv6 inbound firewall. \param bEnable, true to enable the IPv6 inbound firewall, false to disable it.- Parameters:
bEnable- Takes in a parameter of bEnable
-